/*
 * fv3tk
 * Copyright (C) 2009  John Pritchard, jdp@syntelos.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package fv3tk.hid;

/**
 * Joytick motion event
 * 
 */
public interface Stick
    extends InputEvent
{
    public final static int StickEventClass  = 0x100000;

    public final static int StickLeft   = (StickEventClass | 0x1);
    public final static int StickRight  = (StickEventClass | 0x2);

    public boolean isStick();

    /**
     * Stick data
     */
    public byte getMinX();
    /**
     * Stick data
     */
    public byte getMinY();
    /**
     * Stick data
     */
    public byte getMaxX();
    /**
     * Stick data
     */
    public byte getMaxY();

    /**
     * Normalized stick data. 
     * 
     * @return A value between zero and one, inclusive.
     */
    public float getX();
    /**
     * Normalized stick data. 
     * 
     * @return A value between zero and one, inclusive.
     */
    public float getY();
    
}
